3 namespace MediaWiki\Tidy
;
5 use RemexHtml\HTMLData
;
6 use RemexHtml\Serializer\Serializer
;
7 use RemexHtml\Serializer\SerializerNode
;
8 use RemexHtml\Tokenizer\Attributes
;
9 use RemexHtml\Tokenizer\PlainAttributes
;
10 use RemexHtml\TreeBuilder\TreeBuilder
;
11 use RemexHtml\TreeBuilder\TreeHandler
;
12 use RemexHtml\TreeBuilder\Element
;
17 class RemexCompatMunger
implements TreeHandler
{
18 private static $onlyInlineElements = [
66 // Those defined in tidy.conf
75 private static $formattingElements = [
93 * @param Serializer $serializer
95 public function __construct( Serializer
$serializer ) {
96 $this->serializer
= $serializer;
99 public function startDocument( $fragmentNamespace, $fragmentName ) {
100 $this->serializer
->startDocument( $fragmentNamespace, $fragmentName );
101 $root = $this->serializer
->getRootNode();
102 $root->snData
= new RemexMungerData
;
103 $root->snData
->needsPWrapping
= true;
106 public function endDocument( $pos ) {
107 $this->serializer
->endDocument( $pos );
110 private function getParentForInsert( $preposition, $refElement ) {
111 if ( $preposition === TreeBuilder
::ROOT
) {
112 return [ $this->serializer
->getRootNode(), null ];
113 } elseif ( $preposition === TreeBuilder
::BEFORE
) {
114 $refNode = $refElement->userData
;
115 return [ $this->serializer
->getParentNode( $refNode ), $refNode ];
117 $refNode = $refElement->userData
;
118 $refData = $refNode->snData
;
119 if ( $refData->currentCloneElement
) {
120 // Follow a chain of clone links if necessary
121 $origRefData = $refData;
122 while ( $refData->currentCloneElement
) {
123 $refElement = $refData->currentCloneElement
;
124 $refNode = $refElement->userData
;
125 $refData = $refNode->snData
;
127 // Cache the end of the chain in the requested element
128 $origRefData->currentCloneElement
= $refElement;
129 } elseif ( $refData->childPElement
) {
130 $refElement = $refData->childPElement
;
131 $refNode = $refElement->userData
;
133 return [ $refNode, $refNode ];
140 * @param SerializerNode $parent
141 * @param int $sourceStart
142 * @return SerializerNode
144 private function insertPWrapper( SerializerNode
$parent, $sourceStart ) {
145 $pWrap = new Element( HTMLData
::NS_HTML
, 'mw:p-wrap', new PlainAttributes
);
146 $this->serializer
->insertElement( TreeBuilder
::UNDER
, $parent, $pWrap, false,
148 $data = new RemexMungerData
;
149 $data->isPWrapper
= true;
150 $data->wrapBaseNode
= $parent;
151 $pWrap->userData
->snData
= $data;
152 $parent->snData
->childPElement
= $pWrap;
153 return $pWrap->userData
;
156 public function characters( $preposition, $refElement, $text, $start, $length,
157 $sourceStart, $sourceLength
159 $isBlank = strspn( $text, "\t\n\f\r ", $start, $length ) === $length;
161 list( $parent, $refNode ) = $this->getParentForInsert( $preposition, $refElement );
162 $parentData = $parent->snData
;
164 if ( $preposition === TreeBuilder
::UNDER
) {
165 if ( $parentData->needsPWrapping
&& !$isBlank ) {
166 // Add a p-wrapper for bare text under body/blockquote
167 $refNode = $this->insertPWrapper( $refNode, $sourceStart );
169 $parentData = $parent->snData
;
170 } elseif ( $parentData->isSplittable
&& !$parentData->ancestorPNode
) {
171 // The parent is splittable and in block mode, so split the tag stack
172 $refNode = $this->splitTagStack( $refNode, true, $sourceStart );
174 $parentData = $parent->snData
;
179 // Non-whitespace characters detected
180 $parentData->nonblankNodeCount++
;
182 $this->serializer
->characters( $preposition, $refNode, $text, $start,
183 $length, $sourceStart, $sourceLength );
186 private function trace( $msg ) {
187 // echo "[RCM] $msg\n";
191 * Insert or reparent an element. Create p-wrappers or split the tag stack
194 * Consider the following insertion locations. The parent may be:
196 * - A: A body or blockquote (!!needsPWrapping)
197 * - B: A p-wrapper (!!isPWrapper)
198 * - C: A descendant of a p-wrapper (!!ancestorPNode)
199 * - CS: With splittable formatting elements in the stack region up to
201 * - CU: With one or more unsplittable elements in the stack region up
203 * - D: Not a descendant of a p-wrapper (!ancestorNode)
204 * - DS: With splittable formatting elements in the stack region up to
205 * the body or blockquote
206 * - DU: With one or more unsplittable elements in the stack region up
207 * to the body or blockquote
209 * And consider that we may insert two types of element:
213 * We handle the insertion as follows:
215 * - A/i: Create a p-wrapper, insert under it
216 * - A/b: Insert as normal
217 * - B/i: Insert as normal
218 * - B/b: Close the p-wrapper, insert under the body/blockquote (wrap
220 * - C/i: Insert as normal
221 * - CS/b: Split the tag stack, insert the block under cloned formatting
222 * elements which have the wrap base (the parent of the p-wrap) as
223 * their ultimate parent.
224 * - CU/b: Disable the p-wrap, by reparenting the currently open child
225 * of the p-wrap under the p-wrap's parent. Then insert the block as
227 * - D/b: Insert as normal
228 * - DS/i: Split the tag stack, creating a new p-wrapper as the ultimate
229 * parent of the formatting elements thus cloned. The parent of the
230 * p-wrapper is the body or blockquote.
231 * - DU/i: Insert as normal
233 * FIXME: fostering ($preposition == BEFORE) is mostly done by inserting as
234 * normal, the full algorithm is not followed.
236 * @param int $preposition
237 * @param Element|SerializerNode|null $refElement
238 * @param Element $element
240 * @param int $sourceStart
241 * @param int $sourceLength
243 public function insertElement( $preposition, $refElement, Element
$element, $void,
244 $sourceStart, $sourceLength
246 list( $parent, $newRef ) = $this->getParentForInsert( $preposition, $refElement );
247 $parentData = $parent->snData
;
248 $parentNs = $parent->namespace;
249 $parentName = $parent->name
;
250 $elementName = $element->htmlName
;
252 $inline = isset( self
::$onlyInlineElements[$elementName] );
253 $under = $preposition === TreeBuilder
::UNDER
;
255 if ( $under && $parentData->isPWrapper
&& !$inline ) {
256 // [B/b] The element is non-inline and the parent is a p-wrapper,
257 // close the parent and insert into its parent instead
258 $this->trace( 'insert B/b' );
259 $newParent = $this->serializer
->getParentNode( $parent );
260 $parent = $newParent;
261 $parentData = $parent->snData
;
262 $pElement = $parentData->childPElement
;
263 $parentData->childPElement
= null;
264 $newRef = $refElement->userData
;
265 } elseif ( $under && $parentData->isSplittable
266 && (bool)$parentData->ancestorPNode
!== $inline
268 // [CS/b, DS/i] The parent is splittable and the current element is
269 // inline in block context, or if the current element is a block
270 // under a p-wrapper, split the tag stack.
271 $this->trace( $inline ?
'insert DS/i' : 'insert CS/b' );
272 $newRef = $this->splitTagStack( $newRef, $inline, $sourceStart );
274 $parentData = $parent->snData
;
275 } elseif ( $under && $parentData->needsPWrapping
&& $inline ) {
276 // [A/i] If the element is inline and we are in body/blockquote,
277 // we need to create a p-wrapper
278 $this->trace( 'insert A/i' );
279 $newRef = $this->insertPWrapper( $newRef, $sourceStart );
281 $parentData = $parent->snData
;
282 } elseif ( $parentData->ancestorPNode
&& !$inline ) {
283 // [CU/b] If the element is non-inline and (despite attempting to
284 // split above) there is still an ancestor p-wrap, disable that
286 $this->trace( 'insert CU/b' );
287 $this->disablePWrapper( $parent, $sourceStart );
289 // [A/b, B/i, C/i, D/b, DU/i] insert as normal
290 $this->trace( 'insert normal' );
293 // An element with element children is a non-blank element
294 $parentData->nonblankNodeCount++
;
296 // Insert the element downstream and so initialise its userData
297 $this->serializer
->insertElement( $preposition, $newRef,
298 $element, $void, $sourceStart, $sourceLength );
301 if ( !$element->userData
->snData
) {
302 $elementData = $element->userData
->snData
= new RemexMungerData
;
304 $elementData = $element->userData
->snData
;
306 if ( ( $parentData->isPWrapper ||
$parentData->isSplittable
)
307 && isset( self
::$formattingElements[$elementName] )
309 $elementData->isSplittable
= true;
311 if ( $parentData->isPWrapper
) {
312 $elementData->ancestorPNode
= $parent;
313 } elseif ( $parentData->ancestorPNode
) {
314 $elementData->ancestorPNode
= $parentData->ancestorPNode
;
316 if ( $parentData->wrapBaseNode
) {
317 $elementData->wrapBaseNode
= $parentData->wrapBaseNode
;
318 } elseif ( $parentData->needsPWrapping
) {
319 $elementData->wrapBaseNode
= $parent;
321 if ( $elementName === 'body'
322 ||
$elementName === 'blockquote'
323 ||
$elementName === 'html'
325 $elementData->needsPWrapping
= true;
330 * Clone nodes in a stack range and return the new parent
332 * @param SerializerNode $parentNode
333 * @param bool $inline
334 * @param int $pos The source position
335 * @return SerializerNode
337 private function splitTagStack( SerializerNode
$parentNode, $inline, $pos ) {
338 $parentData = $parentNode->snData
;
339 $wrapBase = $parentData->wrapBaseNode
;
340 $pWrap = $parentData->ancestorPNode
;
342 $cloneEnd = $wrapBase;
344 $cloneEnd = $parentData->ancestorPNode
;
347 $serializer = $this->serializer
;
349 $root = $serializer->getRootNode();
351 $removableNodes = [];
352 $haveContent = false;
353 while ( $node !== $cloneEnd ) {
354 $nextParent = $serializer->getParentNode( $node );
355 if ( $nextParent === $root ) {
356 throw new \
Exception( 'Did not find end of clone range' );
359 if ( $node->snData
->nonblankNodeCount
=== 0 ) {
360 $removableNodes[] = $node;
361 $nextParent->snData
->nonblankNodeCount
--;
367 $pWrap = $this->insertPWrapper( $wrapBase, $pos );
371 // End the p-wrap which was open, cancel the diversion
372 $wrapBase->snData
->childPElement
= null;
378 for ( $i = count( $nodes ) - 1; $i >= 0; $i-- ) {
379 $oldNode = $nodes[$i];
380 $oldData = $oldNode->snData
;
382 $element = new Element( $oldNode->namespace, $oldNode->name
, $oldNode->attrs
);
383 $this->serializer
->insertElement( TreeBuilder
::UNDER
, $nodeParent,
384 $element, false, $pos, 0 );
385 $oldData->currentCloneElement
= $element;
387 $newNode = $element->userData
;
388 $newData = $newNode->snData
= new RemexMungerData
;
390 $newData->ancestorPNode
= $pWrap;
392 $newData->isSplittable
= true;
393 $newData->wrapBaseNode
= $wrapBase;
394 $newData->isPWrapper
= $oldData->isPWrapper
;
396 $nodeParent->snData
->nonblankNodeCount++
;
400 foreach ( $removableNodes as $rNode ) {
401 $fakeElement = new Element( $rNode->namespace, $rNode->name
, $rNode->attrs
);
402 $fakeElement->userData
= $rNode;
403 $this->serializer
->removeNode( $fakeElement, $pos );
409 * Find the ancestor of $node which is a child of a p-wrapper, and
410 * reparent that node so that it is placed after the end of the p-wrapper
412 private function disablePWrapper( SerializerNode
$node, $sourceStart ) {
413 $nodeData = $node->snData
;
414 $pWrapNode = $nodeData->ancestorPNode
;
415 $newParent = $this->serializer
->getParentNode( $pWrapNode );
416 if ( $pWrapNode !== $this->serializer
->getLastChild( $newParent ) ) {
417 // Fostering or something? Abort!
423 $victim = $nextParent;
424 $victim->snData
->ancestorPNode
= null;
425 $nextParent = $this->serializer
->getParentNode( $victim );
426 } while ( $nextParent !== $pWrapNode );
428 // Make a fake Element to use in a reparenting operation
429 $victimElement = new Element( $victim->namespace, $victim->name
, $victim->attrs
);
430 $victimElement->userData
= $victim;
433 $this->serializer
->insertElement( TreeBuilder
::UNDER
, $newParent, $victimElement,
434 false, $sourceStart, 0 );
436 // Decrement nonblank node count
437 $pWrapNode->snData
->nonblankNodeCount
--;
439 // Cancel the diversion so that no more elements are inserted under this p-wrap
440 $newParent->snData
->childPElement
= null;
443 public function endTag( Element
$element, $sourceStart, $sourceLength ) {
444 $data = $element->userData
->snData
;
445 if ( $data->childPElement
) {
446 $this->endTag( $data->childPElement
, $sourceStart, 0 );
448 $this->serializer
->endTag( $element, $sourceStart, $sourceLength );
449 $element->userData
->snData
= null;
450 $element->userData
= null;
453 public function doctype( $name, $public, $system, $quirks, $sourceStart, $sourceLength ) {
454 $this->serializer
->doctype( $name, $public, $system, $quirks,
455 $sourceStart, $sourceLength );
458 public function comment( $preposition, $refElement, $text, $sourceStart, $sourceLength ) {
459 list( $parent, $refNode ) = $this->getParentForInsert( $preposition, $refElement );
460 $this->serializer
->comment( $preposition, $refNode, $text,
461 $sourceStart, $sourceLength );
464 public function error( $text, $pos ) {
465 $this->serializer
->error( $text, $pos );
468 public function mergeAttributes( Element
$element, Attributes
$attrs, $sourceStart ) {
469 $this->serializer
->mergeAttributes( $element, $attrs, $sourceStart );
472 public function removeNode( Element
$element, $sourceStart ) {
473 $this->serializer
->removeNode( $element, $sourceStart );
476 public function reparentChildren( Element
$element, Element
$newParent, $sourceStart ) {
477 $self = $element->userData
;
478 if ( $self->snData
->childPElement
) {
479 // Reparent under the p-wrapper instead, so that e.g.
480 // <blockquote><mw:p-wrap>...</mw:p-wrap></blockquote>
482 // <blockquote><mw:p-wrap><i>...</i></mw:p-wrap></blockquote>
484 // The formatting element should not be the parent of the p-wrap.
485 // Without this special case, the insertElement() of the <i> below
486 // would be diverted into the p-wrapper, causing infinite recursion
488 $this->reparentChildren( $self->snData
->childPElement
, $newParent, $sourceStart );
492 $children = $self->children
;
493 $self->children
= [];
494 $this->insertElement( TreeBuilder
::UNDER
, $element, $newParent, false, $sourceStart, 0 );
495 $newParentNode = $newParent->userData
;
496 $newParentId = $newParentNode->id
;
497 foreach ( $children as $child ) {
498 if ( is_object( $child ) ) {
499 $this->trace( "reparent <{$child->name}>" );
500 $child->parentId
= $newParentId;
503 $newParentNode->children
= $children;